<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class CustomValidator</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class CustomValidator</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This validator calls a user defined function to validate the data.</p>
<p class="description"><p>This function/method should be callable by 'call_user_func'.  It needs to accept 2 parameters: <ol><li>the data string to validate</li><li>return the validation by reference</li></ol> It also should return function success as true or false.  <div class="src-code"><ol><li><div class="src-line">&nbsp;<span class="src-key">function&nbsp;</span><span class="src-id">myCallableFunction</span><span class="src-sym">(</span><span class="src-var">$data</span><span class="src-sym">,&nbsp;</span><span class="src-var">$isValid</span><span class="src-sym">)</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-sym">{</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-key">if</span><span class="src-sym">(</span><span class="src-var">$data&nbsp;</span>=&nbsp;<span class="src-str">'good'</span><span class="src-sym">)</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$isValid&nbsp;</span>=&nbsp;<span class="src-id">true</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-key">else</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-var">$isValid&nbsp;</span>=&nbsp;<span class="src-id">false</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;</div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-comm">//return&nbsp;function&nbsp;execution&nbsp;status</span></div></li>
<li><div class="src-line">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="src-key">return&nbsp;</span><span class="src-id">true</span><span class="src-sym">;</span></div></li>
<li><div class="src-line">&nbsp;<span class="src-sym">}</span></div></li>
</ol></div></p></p>
		<p class="notes">
			Located in <a class="field" href="_modules---validators---custom.validator.php.html">/modules/validators/custom.validator.php</a> (line <span class="field">39</span>)
		</p>
		
				
		<pre><a href="../../Nexista/Validator.html">Validator</a>
   |
   --CustomValidator</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$message" title="details" class="var-name">$message</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$params" title="details" class="var-name">$params</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
												
												<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#main" title="details" class="method-name">main</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$message" id="$message"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$message</span>
			 = <span class="var-default"> &quot;is not acceptable&quot;</span>			(line <span class="line-number">59</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Validator error message</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../Nexista/Validator.html#var$message">Validator::$message</a></dt>
						<dd>Validation info message</dd>
					</dl>
		
		

</div>
<a name="var$params" id="$params"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$params</span>
			 = <span class="var-default">array(<br />        'var' =&gt; '', //required - name of flow var to validate<br />        'function' =&gt; ''   //required - user callable function<br />        )</span>			(line <span class="line-number">48</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Function parameter array</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../Nexista/Validator.html#var$params">Validator::$params</a></dt>
						<dd>Function parameter array</dd>
					</dl>
		
		

</div>
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../../Nexista/Validator.html">Validator</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../../Nexista/Validator.html#var$empty">Validator::$empty</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Nexista/Validator.html#var$required">Validator::$required</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../../Nexista/Validator.html#var$result">Validator::$result</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodmain" id="main"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">main</span> (line <span class="line-number">68</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Applies validator</p>
	<ul class="tags">
				<li><span class="field">return:</span> success</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			main
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../../Nexista/Validator.html#methodmain">Validator::main()</a></dt>
						<dd>Applies validator</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../../Nexista/Validator.html">Validator</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodapplyParams">Validator::applyParams()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodgetMessage">Validator::getMessage()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodisEmpty">Validator::isEmpty()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodisRequired">Validator::isRequired()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodisValid">Validator::isValid()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodmain">Validator::main()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodprocess">Validator::process()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodsetEmpty">Validator::setEmpty()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodsetMessage">Validator::setMessage()</a></span><br>
													<span class="method-name"><a href="../../Nexista/Validator.html#methodsetRequired">Validator::setRequired()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Thu, 02 Aug 2007 17:35:17 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
	</p>
	</div></body>
</html>